🐙 octavia-cli: add command to list existing sources, destinations and connections #9642
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alafanechere
changed the title
Base automatically changed from
augustin/octavia-cli/list-connectors
to
master
January 21, 2022 08:14
alafanechere
changed the base branch from
master
to
augustin/octavia-cli/list-connectors
alafanechere
requested review from
cgardens,
lmossman,
marcosmarxm and
harshithmullapudi
|
@lmossman I tried to continue to improve inheritances goodies to avoid repeating shared logic between all the listing commands. |
alafanechere
changed the base branch from
augustin/octavia-cli/list-connectors
to
master
alafanechere
changed the base branch from
master
to
augustin/octavia-cli/list-connectors
lmossman
reviewed
Jan 22, 2022
alafanechere
changed the base branch from
augustin/octavia-cli/list-connectors
to
master
alafanechere
force-pushed
the
augustin/octavia-cli/list-sources-destinations
branch
from
453bcaf
to
9533e93
Compare
alafanechere
changed the base branch from
master
to
augustin/octavia-cli/list-connectors
lmossman
approved these changes
Jan 24, 2022
Comment on lines
9
to
10
| """Compute column width for display purposes: | ||
| Find largest column size, add a padding of two characters. |
There was a problem hiding this comment.
This method description should be updated to reflect the new implementation
| def compute_columns_width(data: List[List[str]], padding: int = 2) -> List[int]: | ||
| """Compute column width for display purposes: | ||
| Find largest column size, add a padding of two characters. | ||
| Returns: |
There was a problem hiding this comment.
Suggested change
| Returns: | |
| Args: |
Comment on lines
+93
to
+111
| class Sources(WorkspaceListing): | ||
| api = source_api.SourceApi | ||
| fields_to_display = ["name", "sourceName", "sourceId"] | ||
| list_field_in_response = "sources" | ||
| list_function_name = "list_sources_for_workspace" | ||
|
|
||
|
|
||
| class Destinations(WorkspaceListing): | ||
| api = destination_api.DestinationApi | ||
| fields_to_display = ["name", "destinationName", "destinationId"] | ||
| list_field_in_response = "destinations" | ||
| list_function_name = "list_destinations_for_workspace" | ||
|
|
||
|
|
||
| class Connections(WorkspaceListing): | ||
| api = connection_api.ConnectionApi | ||
| fields_to_display = ["name", "connectionId", "status", "sourceId", "destinationId"] | ||
| list_field_in_response = "connections" | ||
| list_function_name = "list_connections_for_workspace" |
There was a problem hiding this comment.
The fact that these inherit from a WorkspaceListing made me think: would it make sense to group these commands under a workspace keyword? I.e. the commands would look like
octavia list workspace sources
octavia list workspace destinations
octavia list workspace connections
octavia list connectors sources
octavia list connectors destinations
Do you think this would make it more clear what the difference between these commands are to the user? Or would we just end up with a ton of workspace commands, making the commands unnecessarily long?
I'll leave it up to you to make the final decision here; I don't feel super strongly either way, but just thought I would offer this suggestion in case you liked it
There was a problem hiding this comment.
I like this, looks tidier and will keep the same command "depth" for list subcommands.
alafanechere
force-pushed
the
augustin/octavia-cli/list-sources-destinations
branch
from
37ae4e3
to
88bfbb2
Compare
alafanechere
changed the base branch from
augustin/octavia-cli/list-connectors
to
master
|
Thank you @lmossman for your review and suggestions! |
alafanechere
deleted the
augustin/octavia-cli/list-sources-destinations
branch
This was referenced Jan 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
How
ConnectorDefinitionsclass in aBaseListingclass hosted inlistings.pymodule.ConnectorDefinitions.SourcesConnectorsDefinitions,DestinationsConnectorsDefinitions,Sources,Destinationsinherit fromBaseListing.list sourcesandlist destinationscommands.Recommended reading order
octavia-cli/octavia_cli/list/listings.pyoctavia-cli/octavia_cli/list/commands.pyoctavia-cli/octavia_cli/list/formatting.pyoctavia-cli/unit_tests/test_list/test_listings.pyoctavia-cli/unit_tests/test_list/test_commands.pyoctavia-cli/unit_tests/test_list/test_formatting.py🚨 User Impact 🚨
Two new commands:
octavia list sourcesandoctavia list destinations